Skip to content

docs(readme): strip unimplemented security claims, document actual state - #5

Merged
diskhacker merged 1 commit into
mainfrom
docs/readme-honesty
Apr 16, 2026
Merged

docs(readme): strip unimplemented security claims, document actual state#5
diskhacker merged 1 commit into
mainfrom
docs/readme-honesty

Conversation

@diskhacker

Copy link
Copy Markdown
Owner

Summary

Rewrite the public README so it matches what the Rust binary actually does today. Pulled from the Sprint 1.5 deep audit of sigops-agent@main.

Removed (no code on main):

  • Outbound WebSocket transport (agent uses HTTP long-polling)
  • 8-layer security model (Layers 2 / 7 / 8 are not implemented)
  • mTLS (no tls.rs, no cert handling)
  • Signed command verification (no sha2 / ring in Cargo.toml)
  • Namespace / cgroup sandbox (sandbox.rs does not exist)
  • 24-hour token-rotation claim (rotation happens per-heartbeat, not per-24h)
  • Installer URL get.sigops.dev/agent
  • Docker image on GHCR
  • pm2 / kubectl executor adapters
  • Module-layout diagram showing ws/, tools/, discovery/, security/sandbox.rs, etc. (actual layout is flat: config.rs, discovery.rs, heartbeat.rs, executor.rs, security.rs, health.rs, main.rs, lib.rs)

Kept / clarified (verified in code):

  • Command whitelist
  • Path deny list
  • Execution timeout with SIGKILL
  • Token rotation on each heartbeat cycle
  • Outbound-only HTTP (optional local /health on :9100, disablable with --no-health)
  • 4+1 built-in tools (restart, http, notify_slack, wait, condition)
  • 3-OS CI matrix (Ubuntu / macOS / Windows)

Added:

  • ## Roadmap section listing the unshipped items above (WSS, mTLS, signed commands, sandbox, auto-update, installers, container image, code signing, cargo audit / SBOM)
  • Transport section stating HTTP long-polling explicitly
  • Configuration table with real env vars and CLI flags

Test plan

  • Checked every bullet against the src/ tree
  • Confirmed no ws/, no tls.rs, no sandbox.rs, no sha2/ring in Cargo.toml
  • Reviewer confirms the roadmap captures every feature a customer might have expected from the old README

https://claude.ai/code/session_01VZPc4xQECHmaTddwaq6zf2

Remove claims for WSS transport, mTLS, signed commands, namespace sandbox,
auto-update, installer URL, Docker image, pm2/kubectl adapters, and the
8-layer model. Document actual security model (whitelist + path deny +
timeout + token rotation + outbound-only HTTP). Add Roadmap section.
@coderabbitai

coderabbitai Bot commented Apr 16, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@diskhacker has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 59 minutes and 54 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 59 minutes and 54 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6fb67b7e-5eab-49ae-acd2-f8436366e893

📥 Commits

Reviewing files that changed from the base of the PR and between 1f0357e and 69b0289.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-honesty

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@diskhacker
diskhacker merged commit e325698 into main Apr 16, 2026
3 checks passed
@diskhacker
diskhacker deleted the docs/readme-honesty branch April 17, 2026 03:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant